From 185bcb40270fcb075c8ac66434e0ee781cdecc3b Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 26 May 2004 01:57:54 +0000 Subject: [PATCH] Move docs inline, fixing them on the way. (#143029, Steve Chaplin) Tue May 25 21:54:00 2004 Matthias Clasen * gtk/gtkframe.c: Move docs inline, fixing them on the way. (#143029, Steve Chaplin) --- ChangeLog | 5 ++++ ChangeLog.pre-2-10 | 5 ++++ ChangeLog.pre-2-6 | 5 ++++ ChangeLog.pre-2-8 | 5 ++++ docs/reference/ChangeLog | 4 +++ docs/reference/gtk/tmpl/gtkframe.sgml | 22 ++++----------- gtk/gtkframe.c | 40 +++++++++++++++++++++++++-- 7 files changed, 67 insertions(+), 19 deletions(-) diff --git a/ChangeLog b/ChangeLog index 93d266d2f8..d601de7a6a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue May 25 21:54:00 2004 Matthias Clasen + + * gtk/gtkframe.c: Move docs inline, fixing them on the + way. (#143029, Steve Chaplin) + 2004-05-11 Robert Ögren * gdk/win32/gdkevents-win32.c (propagate): Don't propagate mouse diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 93d266d2f8..d601de7a6a 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +Tue May 25 21:54:00 2004 Matthias Clasen + + * gtk/gtkframe.c: Move docs inline, fixing them on the + way. (#143029, Steve Chaplin) + 2004-05-11 Robert Ögren * gdk/win32/gdkevents-win32.c (propagate): Don't propagate mouse diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 93d266d2f8..d601de7a6a 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +Tue May 25 21:54:00 2004 Matthias Clasen + + * gtk/gtkframe.c: Move docs inline, fixing them on the + way. (#143029, Steve Chaplin) + 2004-05-11 Robert Ögren * gdk/win32/gdkevents-win32.c (propagate): Don't propagate mouse diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 93d266d2f8..d601de7a6a 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +Tue May 25 21:54:00 2004 Matthias Clasen + + * gtk/gtkframe.c: Move docs inline, fixing them on the + way. (#143029, Steve Chaplin) + 2004-05-11 Robert Ögren * gdk/win32/gdkevents-win32.c (propagate): Don't propagate mouse diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 44a972281b..cf25269c70 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +Tue May 25 21:54:55 2004 Matthias Clasen + + * gtk/tmpl/gtkframe.sgml: Move docs inline. + Wed May 19 23:42:40 2004 Matthias Clasen * gdk/gdk-sections.txt: Add the right include for the "X interaction" diff --git a/docs/reference/gtk/tmpl/gtkframe.sgml b/docs/reference/gtk/tmpl/gtkframe.sgml index fe897e1511..7d8e42a62d 100644 --- a/docs/reference/gtk/tmpl/gtkframe.sgml +++ b/docs/reference/gtk/tmpl/gtkframe.sgml @@ -56,8 +56,6 @@ label can be controlled with gtk_frame_set_label_align(). -Create a new Frame, with optional label @label. -If @label is %NULL, the label is omitted. @label: @@ -66,9 +64,6 @@ If @label is %NULL, the label is omitted. - -Set the text of the label. If @label is %NULL, -the current label, if any, is removed. @frame: @@ -82,30 +77,23 @@ the current label, if any, is removed. @frame: @label_widget: - -@title_widget: -Set the alignment of the Frame widget's label. The -default value for a newly created Frame is 0.0. -@frame: The Frame widget. -@xalign: The position of the label along the top edge - of the widget. A value of 0.0 represents left alignment; - 1.0 represents right alignment. -@yalign: The y alignment of the label. Currently ignored. +@frame: +@xalign: +@yalign: -Set the shadow type for the Frame widget. -@frame: The Frame widget. -@type: New shadow type. +@frame: +@type: diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c index 80ae7ffb1e..02a59c55f4 100644 --- a/gtk/gtkframe.c +++ b/gtk/gtkframe.c @@ -263,6 +263,15 @@ gtk_frame_get_property (GObject *object, } } +/** + * gtk_frame_new: + * @label: the text to use as the label of the frame + * + * Creates a new #GtkFrame, with optional label @label. + * If @label is %NULL, the label is omitted. + * + * Return value: a new #GtkFrame widget + **/ GtkWidget* gtk_frame_new (const gchar *label) { @@ -297,6 +306,14 @@ gtk_frame_forall (GtkContainer *container, (* callback) (frame->label_widget, callback_data); } +/** + * gtk_frame_set_label: + * @frame: a #GtkFrame + * @label: the text to use as the label of the frame + * + * Sets the text of the label. If @label is %NULL, + * the current label is removed. + **/ void gtk_frame_set_label (GtkFrame *frame, const gchar *label) @@ -320,7 +337,7 @@ gtk_frame_set_label (GtkFrame *frame, * gtk_frame_get_label: * @frame: a #GtkFrame * - * If the frame's label widget is a #GtkLabel, return the + * If the frame's label widget is a #GtkLabel, returns the * text in the label widget. (The frame will have a #GtkLabel * for the label widget if a non-%NULL argument was passed * to gtk_frame_new().) @@ -346,7 +363,7 @@ gtk_frame_get_label (GtkFrame *frame) * @frame: a #GtkFrame * @label_widget: the new label widget * - * Set the label widget for the frame. This is the widget that + * Sets the label widget for the frame. This is the widget that * will appear embedded in the top edge of the frame as a * title. **/ @@ -404,6 +421,18 @@ gtk_frame_get_label_widget (GtkFrame *frame) return frame->label_widget; } +/** + * gtk_frame_set_label_align: + * @frame: a #GtkFrame + * @xalign: The position of the label along the top edge + * of the widget. A value of 0.0 represents left alignment; + * 1.0 represents right alignment. + * @yalign: The y alignment of the label. A value of 0.0 aligns under + * the frame; 1.0 aligns above the frame. + * + * Sets the alignment of the frame widget's label. The + * default values for a newly created frame are 0.0 and 0.5. + **/ void gtk_frame_set_label_align (GtkFrame *frame, gfloat xalign, @@ -453,6 +482,13 @@ gtk_frame_get_label_align (GtkFrame *frame, *yalign = frame->label_yalign; } +/** + * gtk_frame_set_shadow_type: + * @frame: a #GtkFrame + * @type: the new #GtkShadowType + * + * Sets the shadow type for @frame. + **/ void gtk_frame_set_shadow_type (GtkFrame *frame, GtkShadowType type) -- 2.30.2